home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / spellr20.zip / SPELLR.DOC < prev    next >
Text File  |  1988-09-11  |  6KB  |  145 lines
  1.                   SpellR Copyright (c) JeWeL Software,
  2.                 1985, 1988, all rights reserved  Ver 2.0
  3.  
  4.  
  5.  
  6. I   Introduction
  7.  
  8.     The Spellr.exe program is designed to  check  the  spelling  of  any
  9.     ASCII document and output all of the words that could not  be  found
  10.     in its dictionary to the standard output device. The output for each
  11.     unknown word found in a document is as follows: 
  12.  
  13.         file.ext(line, col) error : unknown_word (number)
  14.  
  15.     The "file.ext" is the name of the the file being  processed,  "line,
  16.     col" is the line number and column  number  for  the  unknown  word,
  17.     "unknown_word" is the actual spelling of the word not known, and the
  18.     "(number)"  is the number of times the unknown word was found in the
  19.     document file. 
  20.  
  21.  
  22. II  Dictionary
  23.  
  24.     The dictionary used with this program contains in excess  of  40,000
  25.     words.
  26.  
  27.     In addition the user can specify any file that contains  a  list  of
  28.     words the should be accepted by the program.  If  no  file  name  is
  29.     given  then the program will search for a default list of words in a
  30.     file  named "SPELLR.DIC". The search for either the user's specified
  31.     word list, or the default word list file "SPELLR.DIC" will  use  the
  32.     current  PATH setting. Thus if the dictionary list file could not be
  33.     found in the current directory then it will search each PATH setting
  34.     trying to locate and open the specified file.
  35.  
  36.     The optional word list is simply an ASCII file  that  contains  word
  37.     that should be accepted  as  correct  in  spelling  with  each  word
  38.     separated by any number of white spaces  (spaces,  tabs,  newlines).
  39.     The total size of this word list is not restricted,  but  if  should
  40.     not  contain in excess of 1,000 to 2,000 words since this will cause
  41.     a delay in program execution.
  42.  
  43.  
  44. III Program Usage
  45.  
  46.     This program executes on any MS-DOS/PC-DOS compatible  computer.  To
  47.     invoke the program to check  the  spelling  of  any  ASCII  document
  48.     simply enter the following: 
  49.  
  50.         SpellR [-tn] [-dmywords] filename
  51.  
  52.     The optional "-tn" (without the quotes) specifies  the  tab  setting
  53.     distance  to use for reporting column numbers. If the tab setting is
  54.     not given a value of four (4) will be used. 
  55.  
  56.     The  optional "-dmywords" (without the quotes) specifies an optional
  57.     list of words that should  be  accepted  as  correct  spelling.  See
  58.     section II, Dictionary for an explanation of the content  and  usage
  59.     of this word list file. 
  60.  
  61.     The "filename" is simply the file to check the spelling on. 
  62.  
  63.     The execution speed for the SpellR.exe program will  vary  depending
  64.     on what type of computer you are using.  In  some  test  cases  this
  65.     program was capabale of processing 150 words per second  on  a  8MHZ
  66.     IBM PC/AT. 
  67.  
  68.  
  69. III BRIEF Editor Usage
  70.  
  71.     Since this error output is similar to the  error  output  from  many
  72.     compiler programs, it is well suited to being processed by the BRIEF
  73.     Editor, in the same manner that this  editor  process  error  output
  74.     from any compiler program. 
  75.  
  76.     To use this program simply use the  BRIEF  macro  compiler  "cm"  to
  77.     compile  the "SpellR.m" file supplied with the "SpellR.exe" program.
  78.     Once you have compiled this program simply place it with all of your
  79.     other compiled BRIEF macros and invoke  it  as  you  would  any  DOS
  80.     program by depressing the F10 key and entering "SpellR". 
  81.  
  82.     Once  the "SpellR" macro is invoked it will write out any changes to
  83.     the current file being processed and invoke the "SpellR.exe" program
  84.     passing the current tab setting, the file  name  being  edited,  and
  85.     re-direct the standard output to a file of the same  name  with  the
  86.     extension ".err". 
  87.  
  88.     Once the "SpellR.exe" program has completed execution  the  "SpellR"
  89.     BRIEF macro will place the cursor on the  first  unknown  word.  The
  90.     unknown word will also  be  displayed  on  the  bottom  prompt  line
  91.     followed by the number of times this word appears in  the  file.  To
  92.     proceed to the next unknown word you simply enter the  "CTRL-N"  key
  93.     the same as you do for  examing  other  errors  when  you  invoke  a
  94.     compiler from within BRIEF. 
  95.  
  96.     The  BRIEF macro is simply a minor modification of the compile macro
  97.     supplied by Solution Systems and thus  is  not  copyrighted  by  the
  98.     author. 
  99.  
  100. IV  Copyright Protection for SpellR.exe
  101.  
  102.     The  SpellR.exe  program  is  copyright  (c)  1985,  1988  by  JeWeL
  103.     Software. All rights reserved. Non-registered users  are  granted  a
  104.     limited license to use this product on a trial basis,  and  to  copy
  105.     the program for  trial  use  by  others  subject  to  the  following
  106.     limitations: 
  107.  
  108.     The  program  is  distributed  in  unmodified  form,  complete  with
  109.     documentation. 
  110.  
  111.     No fee, charge, or other consideration is requested or  accepted  by
  112.     the user. 
  113.  
  114.     The program  is  not  distributed  in  conjunction  with  any  other
  115.     product. 
  116.  
  117.     If  you intend to use SpellR on a regular basis, please register and
  118.     show  your  support  for  the  author.  Commercial,   business,   or
  119.     governmental use by non-registered users is prohibited.
  120.  
  121.     Interested in multiple copies for use at work?  Site  and  corporate
  122.     licenses are available. 
  123.  
  124.     The "SpellR.exe" program is not copy protected.
  125.  
  126.  
  127. V   Information about Spellr.exe
  128.  
  129.     Every effort has been made to insure the correct performance of this
  130.     program. If any problems are encountered with the SpellR.exe program
  131.     please address then to the address below. 
  132.  
  133.     If you use this program on a regular basis, please show your support
  134.     by registering. You may register by sending a check or  money  order
  135.     for $30 to: 
  136.  
  137.                              JeWeL Software
  138.                           9014 N. E. 82nd Ave
  139.                       Vancouver, Washington 98662
  140.                              (206) 892-1559
  141.  
  142.     All registered users will receive notification of any new release of
  143.     the Spellr.exe program.  Program  disks  are  not  included  in  the
  144.     registration fee. 
  145.